ReadSlaveAlias

Reads the alias address from an EtherCAT slave.

Syntax

KsCommandStatus ReadSlaveAlias(
     int SlaveId,
     WORD* Alias
);

Parameters

SlaveId: the index of a slave array. When EtherCAT is started, this index has the same value as the SlaveId, which corresponds to the position of the slave in the network. Please note that after EtherCAT is started in the Operational (Op) state, any addition or removal of slaves from the network will change the position of the slaves in the network (SlaveId). Nevertheless, the index of the slave will remain the same. Newly added devices will be added in the back of the slave array. For all slaves after the change, the index and SlaveId will no longer match. This behavior is only available for physical devices; simulated devices are inapplicable. Please refer to the use cases in EnableHotConnect for more details.

Alias: pointer to the value to receive the alias address. See the AliasAddress in the SlaveStatus structure.

Return value

Returns the KsCommandStatus structure.

Usable EtherCAT states

ecatInit, ecatPreOP, ecatSafeOP, ecatOP

Example

WORD slaveAlias = 0;
WaitForCommand(3, TRUE, ReadSlaveAlias(0, &slaveAlias));

Requirements

See also

WriteSlaveAlias